Your browser does not support HTML5 video.

Click here to play the video.

Scenario keys define items in an application that vary every time a specific scenario is run. Keys can represent files, numbers, character strings or Boolean flags.

Keys are displayed in the Model tab in Project Explorer:

Right-click on the Keys section in Project Explorer > New Key to add a new key.

Scenario keys can be grouped by categories:

1. Right-click on the Keys section in Project Explorer > New Category to add a category.
2. Right-click on the category > New Key to add a Key to that Category.

To define/edit a key:

(see Keys Overview for detailed information about keys)

• Double-click on a key or right-click > Open to display the Key Definition Editor:

1. Type a Name, Title and Description that describes the key.
2. [Optional] Select a Color Label which can be used for filtering and managing purposes through Project Explorer.
3. Select from the provided options the key’s value type. Depending on the value type different settings will be available for the key definition.
   
   
   Note: The colon symbol (:) is not supported as a key value if the Type is Character.
   Note: If you specify a File Name type key, the Scenario Edit dialog will include a browse button to allow the file to be found using a standard Windows File Open dialog. The types of files to be browsed for can be defined by clicking the File Filters button. Scenario Manager will always make the All Files (*.*) category available. Update the File Filters if you want to define specific filters, such as Data Files (*.dat).
4. Select the Control type from the available options for that value type.
   Note: In most value types it is possible to set a default value, which will be the one that will be applied if there is no definition of a value for the key.
5. Double-click on any of the scenario keys available in the right panel of the window > Yes, to switch to and edit any of the keys.
   
   
   Note: System and Application Keys can be turned on/off by checking 'Show System Keys' or 'Show Application Keys' boxes on bottom right. The 'Show Application Keys' is applicable if keys are specific to different applications in the project.
6. Click Apply to save the changes or Update to save the changes and close the Editor window.

Example for a File Name value type:

Setting up a key that will contain the fille path for the network used for assignment

1. Define the key's Name, Title and Description
2. Select File Name in the value type section
3. Select Combo Edit for the Control type
4. Click on +Add Value to add each individual file path that the key can take
   Tip: When editing a key click on any of the values in the list for the file browse option to appear. You can also select from recent files by clicking on the drop-down.
   
   
5. Click on +Add Filter to name and specify the file extension to use as a filter when a user is looking for a file in File Explorer.
6. Click Apply/Update
   
   

Example for Integer Radio buttons :

Setting up a key named “Foryear” that will take either one of these year values, 2010,2020,2030 and 2050:

1. Define Name, Title and Description accordingly
2. Select Integer for the value type
3. Select Radio buttons for the Control type
4. Click on +Add Value to add each individual year that the key can take.
5. Set a default value if needed
6. Click Apply/Update

To rename a key or a category:

• Click on the item and type in the new name
• Right-click > Rename
• Double-click to open the Key Definition Editor and under name type in the new one > Update.

To create a copy of a key:

• Right-click > Duplicate

• Right-click > Remove

• Key color codes:
  • Right-click on a key and select the color you wish to apply to the key to create a copy of a key
    Tip: Use CTRL key to select multiple keys if you want to set a color for multiple keys at once
  • Double-click on a key and select a color from the Color labels in the Key Definition Editor window:
    
    
• Category color codes: All the keys contained in a category will be equally colored, which allows to differentiate keys based on the categories they belong to:
  • Right-click on the category and select the desired color.
    
    
  • It will now be possible to filter the keys by color:
    
    
    Note: Color coding will also be displayed next to the Key's Title in Scenario Manager
    
    

To rearrange the display of keys in Project explorer:

• Use the Filter.. edit box to browse for a specific key or filter them based on their name.
• Click on the filter symbol drop-down to select which keys to display either System Keys or Application Keys or Clear any applied filters:
  
  
• Right-click on the key section in Project Explorer > Expand All/Collapse All to display all keys or only show the categories when available.